---------------------------Sonic Generations Mod--------------------------
--------------------Sonic 06 Definitive Experience v3.0-------------------

This mod features original models, animations and physics from the game Sonic the Hedgehog (2006). This is not just an ordinary character skin mod, with the help of code injection, this is also a proof-of-concept mod that creates new movesets to Sonic Generations by bringing back character movesets from Sonic 06!

This mod currently includes:
-Custom made 06 HUD
-06 Sonic character mod
-06 Sonic + Elise character mod
-Characters with English/Japanese Voice

Optional features:
-06 Result Music
-06 Camera (experimental)
-06 Physics
-06 Button Mapping
-06 Character Movesets (read below)
-Boost gauge starts empty
-Disable lock-on cursor
-Disable Trick on Rainbow Ring & Trick Ramp
-Disable Spin on Dash Panels
-Rapid Spindash for Sonic's moveset
-Running goal for Sonic model

Requirements & Recommendations: 
-Only works with HedgeModManager, SonicGMI is NOT supported!!!
-Putting this mod higher priority than level mods is recommended (STH2006 Project etc.)
-Playing with controller is recommended, keybaord is playable but you won't be able to use R-stick camera

------------------------------------------------------------
Mod configurations:
------------------------------------------------------------
<---General Settings--->
Character Model:
-Select character model to play with

Voice-over Language:
-Select voice-over language (You MUST also change voice-over language at in-game Options for this to work properly)

Result Music:
-Use Generations or Sonic 06 result music

<---Camera Settings--->
Enable 06 Camera (Experimental):
-This allows player to control camera with right-stick in certain places, used left-trigger to reset camera position. This feature is still experimental, known issues like clipping in to terrain etc.

Invert X-Axis:
-Invert X-Axis on right-stick camera control

Invert Y-Axis:
-Invert Y-Axis on right-stick camera control

<---Physics Modification--->
Enable 06 Physics:
-Enable 06 physics, this includes character speed & rail lock-on, disable lock-on cursor is recommended, read below for full details

Use 06 Character Moveset:
-Enable using all current character's movesets from 06, read below for full details

Use 06 Button Mapping:
-Maps all action to X button, including lightdast, stomp and slide, boost maps to right-trigger and drift maps to B button

Boost Gauge Starts Empty:
-Start stages without any boost

Disable Lock-on Cursor:
-Disable lock-on cursor, disable this for homing attack if you want to feel like 06

Disable Trick on Rainbow Ring & Trick Ramp:
-Disable Trick on Rainbow Ring and Trick Ramp, this is NOT the same as community code by Hyper, this retains the rainbow ring animation

Disable Spin on Dash Panels:
-Disable spin ball model on dash panels (recommended for all)

<---Character Settings (Sonic)--->
Rapid Spindash:
-(Required using 06 character movesets) Allow charging spindash while running or spindashing, but this will disable anti-gravity

Running Goal (Sonic only):
-Disable: Use normal goal animation
-Enable All: Always use running goal animation
-STH2006 Project Stages: Use gunning goal on Sonic 06 specific stages (Wave Ocean, Crisis City, Radical Train, Kingdom Valley)
-Custom: Use running goal of user defined stages (see below)

Custom list of Running Goal Stages:
-Separate list of stages by ",", e.g.: ghz200,cpz200,ssz200 etc.

List of stages: Generations Stage (STH2006 Project Stage)
-ghz100: Classic Green Hill (Prelude Stage)
-ghz200: Modern Green Hill (Wave Ocean)
-cpz200: Modern Chemical Plant (Dusty Desert)
-ssz200: Modern Sky Sanctuary (White Acropolis)
-sph200: Modern Speed Highway (Crisis City)
-cte200: Modern City Escape (Flame Core)
-ssh200: Modern Seaside Hill (Radical Train)
-csc200: Modern Crisis City (Tropical Jungle)
-euc200: Modern Rooftop Run (Kingdom Valley)
-pla200: Modern Planet Wisp (Aquatic Base)
*Change 200 to 100 for Classic stages

------------------------------------------------------------
Common Features Highlight
------------------------------------------------------------
-Fully compatible with STH2006 Project, Unleashed Project and Eggmanland mods
-Random homing attack voice clips
-Custom trick jump animations
-Mid-air twirl animation for 06 Sonic
-06 skateboard from White Acropolis
-Destroyed skateboard from Crisis City (does not work in STH2006 Project Demo 3)
-English and Japanese support!
-Lockable 06 Itemboxes
-Rank quotes from Sonic 06
-Super Sonic can choose to fly boost or ground boost
-Boost energy particle effects are changed to chaos drives/light cores from 06, they also go to Sonic directly instead of the HUD, only 1 will spawn from enemies instead of 5 but they will reward 5x the boost
-Iblis monsters will spawn light cores instead of chaos drives, with original sound effect

------------------------------------------------------------
06 Physics Features
------------------------------------------------------------
Character Movement & Controls:
-Speed is reduced to match 06, boosting will be similar to Blue Gem's speed
-Precise control, this includes ground and air, airdash now allows player to change character's direction
-After homing attack, character will fall much faster, maintaining the down speed before homing attack
-Skateboard requires player to push forward to move
-Wall-running is allowed with lower speed
-Jumping will NOT attack enemies like 06
-Gravity-defying homing attack

Rail Physics:
-Rail switching with L-stick is disabled
-Grinding speed is always constant
-Grind Boosters are disabled
-Use action button to do grind tricks to increase grinding speed, up to 4 times
-Boost can also increase grinding speed, but less effective than grind tricks, speed gain does NOT stack
-Rails can be locked on at any part, not just the beginning

Super Form:
-Speed increases compare to normal form
-Field-of-view is set to more viewable values
-Floating boost only triggered by boosting in mid-air, ground boost does not trigger it

Chaos Energy Re-balancing:
-Boosting will drain the meter in 5 seconds
-Object physics will not award any chaos energy
-Tricks will not award chaos energy immediately, only when they reaches Sonic, each reward 5 boost
-Enemies award the amount of chaos energy base on 06, most enemy gives 1, Iblis Crawler/Lancer (blue) gives 2, Buster (yellow) gives 3 etc.

Miscellaneous:
-Lose all rings when damaged
-Various recreated particle effects

------------------------------------------------------------
Character Movesets (Sonic)
------------------------------------------------------------
Bounce Bracelet:
-Press B button (or X button for 06 button layout) in mid-air to stomp and bounce up when hitting the ground, bounce again to gain height to reach higher platforms

Sweep Kick:
-Press and release B button (or X button for 06 button layout) quickly on ground to do Sweep Kick, this will attack surrounding objects and enemies, you can also use it to pass under tight gaps
-Hold L-stick to keep moving after finishing attack, or let go to stop Sonic immediately

Light Speed Dash:
-Press Y button (or X button for 06 button layout) next to a glowing trail of rings to use Light Speed Dash, you can move quickly through the trail of rings

Anti-Gravity:
-Hold down the B button (or X button for 06 button layout), while running, release the button to use Anti-Gravity, you can slide under tight spaces, press B again to cancel the action, the move have maximum duration of 3 seconds

Spindash:
-While standing still, hold down the B button (or X button for 06 button layout) to charge up a spindash, relase to launch the spindash attack, the move have maximum duration of 3 seconds
-If you prefer able to charge spindash while running, enable Rapid Spindash in configuration, but this will disable Anti-Gravity

------------------------------------------------------------
Character Movesets (Sonic + Elise)
------------------------------------------------------------
Stomping:
-Same as Generations, if 06 button layout is enabled X button will be used instead

Light Speed Dash:
-Same as Sonic

Anti-Gravity:
-Same as Sonic

------------------------------------------------------------
Known Issues
------------------------------------------------------------
-The game sometimes can crash upon loading or exiting a stage, this happens rarely with Sonic but more fequently with Sonic+Elise mod, currently no solution has been found for this bug yet, for now just keep restart the game and it will work eventually, once you are able to play a stage and exit to HUB world at least once, it should not crash anymore for the same play session
-When 06 Button Mapping is enabled, navigation hint may not show the correct button

------------------------------------------------------------
Q&A Section
------------------------------------------------------------
Q: I can only play regular Sonic mod, how do I play other characters like Sonic & Elise?
A: You need to use HedgeModManager and right-click to configure mod, please deprecate SonicGMI.

Q: Why is 06 Result Music not working?/I want to disable 06 Result music!
A: See above.

Q: I'm playing with Japanese voice but I can still hear English voice (or vice versa)?
A: To use voice mod properly you must also goto Option in-game and change the appropriate voice-over language.

Q: Sonic isn't using the board in Crisis City when I play demo 3 Crisis City?
A: Yes, because the demo 3 archive is outdated, but this will appear in the later releases!

Q: I can't get over the pit at the beginning of Generations Crisis City with 06 physics, help!
A: After physics rebalancing in v3.0, this pit is now impossible for some characters' 06 physics, please use FreeCam mod to skip past it.

Q: I can't complete Sky Sanctuary Act 2/Adabat Act 1 with 06 physics!
A: Unfortunately, because of the speed, you can't run pass the falling/crushing platforms, use FreeCam mod to skip past it. Alternatively, transform to Super form where you will have much more speed.

------------------------------------------------------------
Change Log
------------------------------------------------------------
v1.0
-Initial release
-New 06 Sonic model mod
-06 English & Japanese voice
-New 06 physics

v2.0
-HedgeModManager configuration support, deprecated SonicGMI support
-Running goal for 06 Sonic model
-Removed Sonic's mouth from events in 06 (thanks to ItsHelias94)
-Better 06 Sonic materials
-06 Sonic animation fixes
-Sonic + Elise model mod
-New 06 springs
-Added cutscene skipping made by Skyth
-Added loading hint removal
-Added optional 06 result music configuration

v2.1
-Better dashpanel & jump panel materials
-1up and 10ring now show as 06 itembox

v2.2
-Revamped configurations, now much cleaner and also make use of dll mods
-Fixed running goal animation not needing to replace idle animation!
-Added rank result comment voice code mod!
-Added various community code by Hyper (Disable lock-on cursor/spin on dash panels etc.)
-Updated ring UI texture (Credit goes to Hyper for upscaled texture)
-Moved lock-on cursor disable to a separate option in config
-Combined all rank animations into a single archive
-Brought back button prompts (except for A-A homing attack and Y light speed dash)
-Further reduced duplicated textures in LoadingHint

v3.0
-06 Super Sonic release
-06 Sonic Complete Moveset Recreation
-06 Physics adjustment to match 06 values (precise air controls, constant slide speed etc.)
-06 Rail Grinding Physics Recreation (enabled for 06 physics only)
-06 Particle Effect Recreation
-Disable grind squat and use grind trick immediately, also added sfx from 06
-Itembox (1up and 10ring) can now be locked
-Added complete stage voice and disabled rank animation skip
-Additional code to disable lock-on cursor on boss fights
-Added option to use E3 result music
-Disable lightdash navigation prompts
-Included Boost Particle (Chaos Energy) goes to Sonic code
-06 Sonic/Sonic+Elise now uses the correct brake turning animation
-Enemies will spawn chaos drives and iblis monsters will spawn light cores

------------------------------------------------------------
Credits
------------------------------------------------------------
brianuuu (brianuuuSonic)
-Importing models from 06
-Animation fixes to fit in Generations
-Custom animations
-06 custom physics
-06 character movesets coding
-06 particle effects recreation
-Voice mod, enemy sound effects
-Custom Generations style 06 HUD
-DLL mod codes

Skyth
-Various tools
-Cutscene skipping mod
-anm.hkx clean script to reduce animation size
-No Boosting Animation When Grinding code
-Custom animation injection code
-Coding guidence

ItsHelias94
-Models/Materials fixing
-Sonic+Elise goal/idle blinking animation

Mario Tainaka
-Sound management
-Character voice clips
-Various gameplay sound effects
-Beta testing

UltimateDarkman
-Various custom animations
-Elise's materials
-06 springs

Chimera
-Coding help
-Camera mod collaboration

Zoney (TwlightZoney)
-Chaos Drive/Light Core models & materials

PTKickass
-Boost Gauge Starts Empty code
-Beta testing

Crash5band
-Creator of Glitter Studio (particle effect editor)

Hyper
-Disable Homing Redicle code
-Disable Spin Dash on Dash Panels code
-Disable Boost Button Prompt code
-Disable Light Dash Hints code
-Disable Rail Boosters code

Sajid
-Coding guidence

Joeylaw123
-Beta testing
